/*
 * Copyright (c) 2009, Hamish Morgan. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the University of Sussex nor the names of its
 *    contributors may be used to endorse or promote products derived from
 *    this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
package locusts.server.behaviours;

import locusts.common.entities.EntityList;

/**
 * AbstractBehaviour implements Behaviour adding a weight parameter.
 * The weight is used to prioritise the steering of one behaviour over
 * another.
 * 
 * @author Hamish Morgan Morgan
 */
public abstract class AbstractBehaviour implements Behaviour {

    private static final double DEFAULT_WEIGHT = 1.0d;
    private double weight;

    protected AbstractBehaviour(double weight) {
        setWeight(weight);
    }

    protected AbstractBehaviour() {
        this(DEFAULT_WEIGHT);
    }

    public void setWeight(double weight) {
        if (Double.isNaN(weight) || Double.isInfinite(weight))
            throw new IllegalArgumentException();
        this.weight = weight;
    }

    public double getWeight() {
        return weight;
    }

    public void initialize(EntityList entities) {
    }

    public void clean() {
    }

    @Override
    public boolean equals(Object obj) {
        if (obj == null) return false;
        if (getClass() != obj.getClass()) return false;
        final AbstractBehaviour other = (AbstractBehaviour) obj;
        if (this.weight != other.weight) return false;
        return true;
    }

    @Override
    public int hashCode() {
        return 71 * 3 + (int) (Double.doubleToLongBits(this.weight) ^
                (Double.doubleToLongBits(this.weight) >>> 32));
    }
}
